Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include documentation sources in sdist #240

Merged
merged 1 commit into from
Apr 10, 2023
Merged

Conversation

mgorny
Copy link
Contributor

@mgorny mgorny commented Apr 10, 2023

Changes proposed in this PR

Add documentation sources to the list of files included in sdist archives, in order to make it possible to build offline documentation using them. This is necessary in order to make it possible for Linux distributions such as Gentoo to be able to use sdists.

  • Tests added/updated
  • Documentation updated

Is your code right?

  • PEP8 compliant
  • flake8 passed

Add documentation sources to the list of files included in sdist
archives, in order to make it possible to build offline documentation
using them.  This is necessary in order to make it possible for Linux
distributions such as Gentoo to be able to use sdists.
@mgorny
Copy link
Contributor Author

mgorny commented Apr 10, 2023

That said, I've noticed that the sdist on PyPI currently has venv directory — I don't know how it was added there, so I can't test a "fix" but I suspect you may want to exclude it explicitly.

@BoboTiG
Copy link
Owner

BoboTiG commented Apr 10, 2023

Thanks @mgorny !

Can you fix the venv stuff at the same time? 🙏🏻 I guess it was added in 426826b, maybe do you know a better fix for such a warning?
FTR, my setup is:

python -m venv venv
. venv/bin/activate
python -m pip install -r dev-requirements.txt
python -m build

@BoboTiG
Copy link
Owner

BoboTiG commented Apr 10, 2023

That said, I've noticed that the sdist on PyPI currently has venv directory — I don't know how it was added there, so I can't test a "fix" but I suspect you may want to exclude it explicitly.

If you can too, enhance the test-setup.py file to check the outout with wanted, and unwanted, files to prevent regressions. I will do it after your PR if you can't, no pression :)

@mgorny
Copy link
Contributor Author

mgorny commented Apr 10, 2023

Can you fix the venv stuff at the same time? 🙏🏻 I guess it was added in 426826b, maybe do you know a better fix for such a warning?

I think that's the correct fix but tbh I'm not an expert on setuptools anymore.

FTR, my setup is:

python -m venv venv
. venv/bin/activate
python -m pip install -r dev-requirements.txt
python -m build

This doesn't seem to include venv for me either. I suspect the right entry would be either prune venv or recursive-exclude venv * but I don't want to add it blind if I can't reproduce.

If you can too, enhance the test-setup.py file to check the outout with wanted, and unwanted, files to prevent regressions. I will do it after your PR if you can't, no pression :)

I'm afraid that's too much work for me right now.

@BoboTiG
Copy link
Owner

BoboTiG commented Apr 10, 2023

I'll merge your PR, and fix the venv stuff right after. Thanks :)

@BoboTiG BoboTiG merged commit d5b71d1 into BoboTiG:master Apr 10, 2023
@mgorny
Copy link
Contributor Author

mgorny commented Apr 10, 2023

Thank you!

@mgorny mgorny deleted the docs-sdist branch April 10, 2023 16:04
@BoboTiG
Copy link
Owner

BoboTiG commented Apr 10, 2023

I am having hard time with that stuff, so I created #243, if anyone can give a hand :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants